Skip to content

fix: revert revert and add ssh back into guide docs #4071

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Sep 7, 2021

Conversation

jsjoeio
Copy link
Contributor

@jsjoeio jsjoeio commented Aug 30, 2021

#4042 broke our docs website, #4060 reverted the change.

There are 2 problems in there. There are 4 back ticks at the end of one block. Changing the line “output” to “console” should fix it

Thanks to @mterhar, I think we found the issue.

We're working with @BrunoQuaresma to prevent issues like this in the future.

Related:

@jsjoeio jsjoeio requested a review from a team as a code owner August 30, 2021 18:04
@jsjoeio jsjoeio self-assigned this Aug 30, 2021
@jsjoeio jsjoeio added the docs Documentation related label Aug 30, 2021
@jsjoeio jsjoeio added this to the 3.12.0 milestone Aug 30, 2021
@codecov
Copy link

codecov bot commented Aug 30, 2021

Codecov Report

Merging #4071 (aed32c2) into main (67b23aa) will not change coverage.
The diff coverage is n/a.

❗ Current head aed32c2 differs from pull request most recent head 2c1aed2. Consider uploading reports for the commit 2c1aed2 to get more accurate results
Impacted file tree graph

@@           Coverage Diff           @@
##             main    #4071   +/-   ##
=======================================
  Coverage   64.12%   64.12%           
=======================================
  Files          36       36           
  Lines        1873     1873           
  Branches      379      379           
=======================================
  Hits         1201     1201           
  Misses        571      571           
  Partials      101      101           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 67b23aa...2c1aed2. Read the comment docs.

@github-actions
Copy link

github-actions bot commented Aug 30, 2021

✨ Coder.com for PR #4071 deployed! It will be updated on every commit.

@jsjoeio
Copy link
Contributor Author

jsjoeio commented Aug 30, 2021

Checked the preview. Looks good! @BrunoQuaresma any idea why the docs are making this shield round?

When I look at it in the browser, it's square like the others. See here

image

@BrunoQuaresma
Copy link
Contributor

@jsjoeio I will check it. Probably a random CSS class. Also, when adding badges, it is recommended to make it a link, even if it is only an image. When it is an image, you can make it a link pointing to the image itself. It is how GH does to make their badges inline. You can inspect how our README.md looks like on GH inspecting the badges.

@BrunoQuaresma
Copy link
Contributor

@jsjoeio also, looks like we are not closing a code block here:
Screen Shot 2021-08-31 at 10 37 57
It looks like the bash block is inside of another block.

@jsjoeio
Copy link
Contributor Author

jsjoeio commented Aug 31, 2021

When it is an image, you can make it a link pointing to the image itself. It is how GH does to make their badges inline. You can inspect how our README.md looks like on GH inspecting the badges.

Ah okay, I'll match that.

@jsjoeio
Copy link
Contributor Author

jsjoeio commented Aug 31, 2021

also, looks like we are not closing a code block here:

Nice catch! I'll fix that too

@jsjoeio
Copy link
Contributor Author

jsjoeio commented Aug 31, 2021

When it is an image, you can make it a link pointing to the image itself. It is how GH does to make their badges inline. You can inspect how our README.md looks like on GH inspecting the badges.

Ah okay, I'll match that.

I just checked and these are already links 🤔 Not sure what else we can do then.

image

@jsjoeio jsjoeio force-pushed the jsjoeio-fix-revert-docs branch from 9b65bb5 to 3d3b8ab Compare August 31, 2021 18:02
@jsjoeio
Copy link
Contributor Author

jsjoeio commented Aug 31, 2021

Ready for another review! @BrunoQuaresma

@BrunoQuaresma
Copy link
Contributor

@jsjoeio I sent a PR just fixing the link on the terminal badge.
Screen Shot 2021-09-01 at 10 14 03

Copy link
Contributor

@BrunoQuaresma BrunoQuaresma left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@jsjoeio
Copy link
Contributor Author

jsjoeio commented Sep 1, 2021

I'll merge after I get this merged in: #4085

@jsjoeio jsjoeio marked this pull request as draft September 3, 2021 21:04
@jsjoeio jsjoeio marked this pull request as ready for review September 3, 2021 21:10
@im-coder-lg
Copy link
Contributor

im-coder-lg commented Sep 6, 2021

@jsjoeio I need to tell, the ngrok URL changes every time, as well as the port. One time you run ngrok, you get 0.tcp.ngrok.io and port 19028, but the next time you run it, you will get 2.tcp.ngrok.io and 10320, and it goes on. So, add in this case, to the ngrok guide where the port is mentioned and add a note that the port and the URL always changes so you have to use the URL and the port given on the terminal.

@jsjoeio
Copy link
Contributor Author

jsjoeio commented Sep 7, 2021

Ahh good call @im-coder-lg - thanks for mentioning that!

@jsjoeio jsjoeio force-pushed the jsjoeio-fix-revert-docs branch from aed32c2 to 2c1aed2 Compare September 7, 2021 21:51
@jsjoeio jsjoeio enabled auto-merge September 7, 2021 21:51
@jsjoeio jsjoeio disabled auto-merge September 7, 2021 23:13
@jsjoeio jsjoeio merged commit 8fde5f4 into main Sep 7, 2021
@jsjoeio jsjoeio deleted the jsjoeio-fix-revert-docs branch September 7, 2021 23:13
@im-coder-lg
Copy link
Contributor

👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation related
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants